home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr31 / udproc12.zip / UDPROC.DOC < prev    next >
Text File  |  1993-05-01  |  20KB  |  471 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                UDPROC 
  22.  
  23.                       Upload Directory PROCessor
  24.                              Version 1.02
  25.  
  26.                             Copyright 1990      
  27.                                   by
  28.                           ZebbWare Products
  29.                            39 Wilson Road 
  30.                       Portsmouth, NH 03801-5737 
  31.                             (603)433-5969
  32.                  BBS: (603)436-7475 (300-9600+ baud)
  33.  
  34.                          ALL RIGHTS RESERVED!
  35.  
  36.                         ********************     (TM)
  37.                         ********************                         
  38.                       ......           ***....                          
  39.                         ..           ***  ..                      
  40.                          ..      ..***   ..                            
  41.                           ..    ....    ..                                  
  42.                            ..  *** ..  ..                                 
  43.                             .***    ....   *          
  44.                            ***.      ..   **
  45.                          *******************
  46.                         ********************
  47.  
  48.             
  49.  
  50.  
  51.                       Table of Contents
  52.  
  53.  
  54.  
  55.  
  56.      What Am I?.................................................1
  57.      Introduction...............................................1
  58.          License, Prices, Warnings & Copyrights.................1
  59.          Contacting ZebbWare Products...........................2
  60.          Other 'ZebbWare Products' Products.....................2
  61.          List of Files on Disk (or in Archive)..................2
  62.      Using the Upload Directory PROCessor.......................3
  63.          Option  /D (Directory to process)......................3
  64.          Option  /H (Header file to use)........................4
  65.          Option  /O# (Override automatic deletion)..............4
  66.          Option  /W (Write over existing archives)..............5
  67.          Option  /T (Time & Date Stamping)......................5
  68.          Option  /F (FILES.BBS processing)......................5
  69.          Option  /A (Add Missing files to FILES.BBS)............5
  70.      Example (program flow).....................................6
  71.      Temporary Files & Directory................................7
  72.      Error & Return Codes.......................................7
  73.      Required Programs (Setup & Memory Information!)............7
  74.      Last Word..................................................7
  75.  
  76. Upload Directory Processor (C) 1990 ZebbWare Products   16/Jan/1990  Page 1
  77.  
  78.  
  79.  
  80. What Am I?
  81.  
  82.      The Upload Directory PROCessor (UDPROC.EXE) will test & convert
  83. all archives in a given directory to the PAK format.  Optionally
  84. saving the original & the damaged archives.  It will update a
  85. FILES.BBS file to reflect the new file extension.  It will use the 
  86. original archives date & time stamp for the new PAK file.
  87.  
  88.  
  89. Introduction
  90.  
  91.      The Upload Directory Processor was originally designed for my use 
  92. with an Opus-Based Bulletin Board System.  However, it can & does 
  93. work on any directory without an Opus BBS installed. I needed a  
  94. utility that would perform various tasks on each archive file in a
  95. given directory.  Those various tasks were: 1) Test the archives for   
  96. any damage (CRC errors, etc...).  2) If they were damaged, then either
  97. delete them or rename them to *.DAM.  3a) If they were intact and 
  98. they were in the 'PAK' format, I would run the PAK program with the
  99. C option (PAK C FILENAME) to be sure the file was PAK'd with the newest   
  100. version of PAK (currently v2.10).  3b) If they were in the ZIP or
  101. LZH format, I would convert them to 'PAK' format.  (If they were ARC  
  102. format I would rename it to PAK and process accordingly).  4) I would
  103. add an extended header to the newly tested/converted PAK file (PAK H).
  104. 5) I would then change the date & time of the new archive to match
  105. the old archives date & time.  This was so my BBS users would not think
  106. these files were new uploads if they had already seen them under the
  107. old archive format.  6) I would update the FILES.BBS file (for opus) to 
  108. reflect the new file extension.  This is what this program basically does!
  109. It does, however, have a few options. (explained further below)
  110.  
  111.  
  112. License, Prices, Warnings & Copyrights
  113.  
  114.      The Upload Directory Processor is a copyrighted work, protected
  115. by United States law and international treaty provisions.  There is
  116. no charge for this program, however there is a $10 charge if you want
  117. a copy of the source code.  If you would like the C source code for
  118. UDPROC.EXE, send a check or money order for $11.50 (1.50 ship & hndl)
  119. to ZebbWare Products, Attention: Source Request Dept., 39 Wilson Road,
  120. Portsmouth, New Hampshire 03801-5737.
  121.  
  122.      Since there is no charge for the program, Please feel free to
  123. distribute it to other bulletin boards & friends.  Also, why not drop
  124. me a card and let me know your thoughts!
  125.  
  126.      THIS IS A USE AT YOUR OWN RISK PROGRAM!!!  ZebbWare Products & the
  127. the author will NOT be responsible for lost or damaged files.  I make
  128. no Guarantees or promises!  It does, however, work fine for me!
  129.     
  130. UDPROC interfaces with the following OUTSTANDING compression programs:
  131.  
  132.     PAK - (C) 1989, 1990 NoGate Consulting.  All Rights Reserved.
  133.     PKZIP/PKUNZIP - (C) 1989 PKWARE Inc.  All Rights Reserved.
  134.     LHARC - (C) 1989 Haruyasu Yoshizaki.  All Rights Reserved.
  135.  
  136. Upload Directory Processor (C) 1990 ZebbWare Products   16/Jan/1990  Page 2
  137.  
  138.  
  139. Contacting ZebbWare Products
  140.  
  141.      If you wish to contact ZebbWare Products with questions,
  142. comments, or suggestions, we can be reached several different ways.
  143.  
  144.      You can call our answering machine at (603)433-5969.
  145.                                  or
  146.      You can call Spectre BBS at (603)436-7475 / 300-9600 HST /8N1,
  147. FidoNet Address (1:132/202).
  148.  
  149.      You can also address letters to:
  150.  
  151.                           ZebbWare Products
  152.                           39 Wilson Road
  153.                           Portsmouth, New Hampshire
  154.                                       03801-5737
  155.  
  156.  
  157.      
  158. Other 'ZebbWare Products' Products
  159.  
  160.      SID, Software Inventory Database.  A Nice way to keep track of   
  161. all your software.  Database is stored in dBase III Plus file format
  162. so dBase compatible products will be able to access the data.
  163. Features include: Sorting, Variety of sorted reporting, Wastebasket 
  164. (all deleted entries are stored in the wastebasket until you empty it), 
  165. Add, Modify, Inquiry, Browse and more.
  166.  
  167.      FLOPINS, a utility for creating inserts for floppy disks.  No
  168. longer will you have to squint to see what's written on a tiny
  169. floppy label.  Now you can create floppy inserts on your Epson
  170. compatible printer.  Slide these into your 5 1/4 floppy sleeve and    
  171. identifying whats on a floppy becomes a breeze.
  172.  
  173.      ZebbWare Products also makes available custom programming in a wide
  174. variety of languages for a wide variety of environments.  Looking to
  175. help the small / medium business get the most from computerization.
  176. Please Write or Call for further information.
  177.  
  178. List of Files on Disk (or in Archive)
  179.  
  180.      Your Upload Directory PROCessor disk should contain the
  181. following files:
  182.  
  183.      UDPROC.EXE  - ZebbWare's Upload Directory PROCessor (18649 bytes)
  184.      UDPROC.DOC  - This documentation you're reading right now!
  185.      README.1ST  - (Optional) If this file exists, it will contain
  186.                    any last minute information.
  187.  
  188.  
  189.  
  190. Upload Directory Processor (C) 1990 ZebbWare Products   16/Jan/1990  Page 3
  191.  
  192.  
  193.  
  194. Options
  195.  
  196.      By typing UDPROC and hitting the ENTER key, UDPROC will display
  197. a usage screen which looks something like this:
  198.  
  199.  +---------------------------------------------------------------------+
  200.  |                                                                     |
  201.  | ZebbWare Products (R) Upload Directory Processor  Version 1.02      |
  202.  | Copyright (c)1990 ZebbWare Products - All Rights Reserved!          |
  203.  |                                                                     |
  204.  | usage: C:\DOS\UDPROC.EXE /D{path} [ switches... ]                   |
  205.  |        Valid Switches are:                                          |
  206.  |        /d{path} or /D{path} - Path of directory to process          |
  207.  |        /h{path} or /H{path} - Path & Filename of extended header    |
  208.  |        /o# or /O# - Where # = 1, 2, or 3                            |
  209.  |                 1) Don't delete original archives                   |
  210.  |                 2) Don't delete damaged archives (makes DAMAGED.BBS)|
  211.  |                 3) Don't delete originals or damaged archives       |
  212.  |        /f or /F - Don't touch the FILES.BBS file                    |
  213.  |        /t or /T - Don't keep original archive Creation date & time  |
  214.  |        /w or /W - Write over existing archives                      |
  215.  |                                                                     |
  216.  |  Example: C:\DOS\UDPROC.EXE /dc:\dos\workdir /Hc:header.txt /o2     |
  217.  |                                                                     | 
  218.  +---------------------------------------------------------------------+
  219.  
  220.      The switches are as follows:
  221.  
  222.      /d{path} or /D{path} where {path} is the FULL path of the
  223.                           directory you want to convert.  
  224.  
  225.       For example, if you want to convert all archives in the 
  226. C:\OPUS\UPLOADS directory, you would execute the program like this:
  227.             UDPROC /DC:\OPUS\UPLOADS  or UDPROC /dC:\opus\UpLoAdS
  228.  
  229.        As you can see Upper & Lower case doesn't matter.  If you
  230. wanted to convert everything in the root directory of drive d: you 
  231. would use the program like this:
  232.             UDPROC /dd:\   or  UDPROC /Dd:\
  233.  
  234.        The /D switch is a REQUIRED switch.  If you do not specify
  235. this switch on the command line, you will be prompted to enter the
  236. Directory you wish to process.  (This is assuming you have entered at
  237. least one other switch.  If you don't specify the /D switch
  238. and you don't specify any other switches, you will simply get the
  239. usage screen shown above.)
  240.  
  241.        If you enter an invalid path with the /D switch, UDPROC will
  242. beep at you and tell you what directory couldn't be found.  Try
  243. entering garbage after the /d switch and you'll see what I mean.
  244.  
  245.  
  246.  
  247. Upload Directory Processor (C) 1990 ZebbWare Products   16/Jan/1990  Page 4
  248.  
  249.  
  250.  
  251. Options (continued)
  252.  
  253.       /h{path} or /H{path} where {path} is the FULL path of the
  254.                            file which represents the Extended Archive
  255.                            header you wish to add to your archives.
  256.  
  257.       For example, If you want to convert all archives in the C:\UPLOADS
  258. directory and you wanted to include the header file D:\TEXT\HEADER.TXT, 
  259. you would execute the program like this:
  260.             UDPROC /dC:\UPLOADS /Hd:\text\header.txt
  261.  
  262.       Again, Upper & lower case does not matter.  If the
  263. path/filename following the /H does not exist, UDPROC will beep at
  264. you and tell you it couldn't find the file.
  265.     
  266.  
  267.       /o# or /O#  Where # = 1, 2, or 3. - Overrides deletion of
  268.                   archives.  It will continue to rename *.ARC files
  269.                   to *.PAK regardless of this switch.
  270.  
  271.              /O1 - Overrides deletion of the original archives.  (with
  272.                    1 exception, see /W switch further on).  
  273.   
  274.     Example:  If Drive C: root directory contains 2 files in it
  275. (FILE1.ZIP & FILE2.LZH), when UDPROC is executed like this: UDPROC /Dc:\ 
  276. /o1 it will convert FILE1.ZIP to FILE1.PAK and FILE2.LZH to FILE2.PAK. 
  277. With the /O1 switch specified, the directory will now contain 4 files:
  278. FILE1.ZIP, FILE1.PAK, FILE2.LZH & FILE2.PAK.  If this switch is NOT
  279. used, the directory will only contain the *.PAK files.
  280.  
  281.              /O2 - Overrides deletion of the damaged archives.  Also
  282.                    creates the DAMAGED.BBS file  
  283.   
  284.      If FILE1.ZIP turned out to contain errors in it (such as Bad CRC),
  285. and the /O2 switch was specified, the damaged archive would be renamed
  286. to FILE1.DAM.  If the /O2 was not specified and FILE1.ZIP was damaged, 
  287. UDPROC will simply delete it.
  288.  
  289.      OPUS: UDPROC will edit the FILES.BBS file (if found) to reflect
  290. the new file extensions (assuming /f wasn't used).  EVEN IF YOU USE
  291. /O1 TO SAVE the original archives, FILES.BBS will still be updated.  
  292. The only exception is if you use the /O2 switch and the file is damaged.
  293. UDPROC will then create a file called DAMAGED.BBS.  It will extract the
  294. filename & description of the damaged archive from the FILES.BBS file and
  295. place it in the DAMAGED.BBS file.
  296.  
  297.              /O3 - Is a combination of /O1 & /O2.  It Overrides the 
  298.                    deletion of the Original archives as well as the
  299.                    damaged archives.  (See /O1 & /O2 for more info)  
  300.  
  301.  
  302.  
  303. Upload Directory Processor (C) 1990 ZebbWare Products   16/Jan/1990  Page 5
  304.  
  305.  
  306.  
  307. Options (continued)
  308.  
  309.       /w or /W  write over existing .PAK archives
  310.  
  311.       If the directory you're converting has 2 archives with the same
  312. filename but different extensions, you have one of 2 options.  Let's
  313. assume the directory you're converting has 2 files in it called
  314. FILE1.ZIP and FILE1.PAK.  If you specifed the /W switch, UDPROC will
  315. delete FILE1.PAK and then convert FILE1.ZIP into FILE1.PAK.  If you
  316. don't specify the /W switch, UDPROC will delete the FILE1.ZIP file
  317. and test/convert FILE1.PAK.  
  318.       UDPROC is not too kind here.  You can keep one or the other but
  319. not both.  Perhaps if there is enough feedback, a future release will
  320. allow you to keep both.  If you really want this option, Contact
  321. ZebbWare products and let us know!
  322.  
  323.  
  324.       /t or /T  Time-Stamping override
  325.  
  326.       UDPROC, by default, will keep the original archives date & time
  327. stamp.  If you're converting FILE1.ZIP and it was created 05-28-89 at
  328. 5:02am, then by default, FILE1.PAK will also show that it was created
  329. 05-28-89 at 5:02am.
  330.       If you specify the /T switch, then UDPROC will NOT keep the
  331. original date & time stamp and FILE1.PAK will show that it was
  332. created Today. (Uses PC's System clock)
  333.  
  334.       /f or /F  FILES.BBS file processing override
  335.  
  336.       UDPROC, again by default, will look for, and if found, edit
  337. your FILES.BBS file (used on Opus BBS systems).  It will update the
  338. filenames in the FILES.BBS file to reflect the new .PAK file
  339. extensions.  If damaged files are deleted, it will remove the entry
  340. from FILES.BBS.
  341.       By specifying the /F switch, UDPROC will NOT touch the
  342. FILES.BBS file.  It will be left in the same condition it was prior
  343. to UDPROC being executed.
  344.       (NOTE:  If you are not running an OPUS BBS, and you have no
  345. FILES.BBS file, the /F is basically useless.  However, it may help
  346. UDPROC to execute a little faster if you do specify it)
  347.  
  348.      /a or /A  Add newly PAK'd archives to FILES.BBS
  349.  
  350.      UDPROC, by default, does not add archive filenames to the
  351. FILES.BBS file if they are not already in it.  If you specify the /A
  352. switch however, then UDPROC will add the archive file name to the end
  353. of the FILES.BBS file with a description of (Description Missing).
  354.  
  355.      NOTE: If the /F switch is specified then the /A switch is ignored.
  356.  
  357.  
  358.  
  359. Upload Directory Processor (C) 1990 ZebbWare Products   16/Jan/1990  Page 6
  360.  
  361.  
  362. Examples
  363.  
  364.       (Key)
  365.       <CR>  means hitting the RETURN or ENTER key
  366.  
  367.  
  368.       (Example #1)
  369.         UDPROC /dc:\dos\archives /hc:\archive.hdr /o3 /w <CR>
  370.  
  371.       (Program Logic - A Basic Overview)
  372.         Get a Filename in directory \dos\archives on drive c:
  373.         IF it has a .ZIP, .LZH, .ICE, .ARC, .PAK extension 
  374.            if It's .ARC rename it to .PAK & update FILES.BBS
  375.            IF it's .ICE rename it to .LZH & update FILES.BBS
  376.  
  377.            If it's .PAK
  378.                Test it (PAK T {filename})
  379.                if it had errors in it
  380.                   rename it to {filename}.DAM (/o3 was specified)
  381.                   copy info from FILES.BBS to DAMAGED.BBS
  382.                if it didn't have errors
  383.                   Convert it (PAK C {filename})
  384.                   Header was specified so add it 
  385.                       (PAK H {filename} @c:\archive.hdr)
  386.  
  387.            If it's .ZIP
  388.                Delete corresponding .PAK file if any (/w was specified)
  389.                Un Zip it
  390.                if it had errors in it
  391.                   rename it to {filename}.DAM (/o3 was specified)
  392.                   copy info from FILES.BBS to DAMAGED.BBS
  393.                if it didn't have errors
  394.                   Convert it (PAK A {filename} {files from .Zip archive})
  395.                   Header was specified so add it 
  396.                       (PAK H {filename} @c:\archive.hdr)
  397.                   /o3 was specified so don't delete {filename}.ZIP
  398.  
  399.            If it's .LZH
  400.                Delete corresponding .PAK file if any (/w was specified)
  401.                Un LHArc it
  402.                if it had errors in it
  403.                   rename it to {filename}.DAM (/o3 was specified)
  404.                   copy info from FILES.BBS to DAMAGED.BBS
  405.                if it didn't have errors
  406.                   Convert it (PAK A {filename} {files from .LZH archive})
  407.                   Header was specified so add it 
  408.                       (PAK H {filename} @c:\archive.hdr)
  409.                   /o3 was specified so don't delete {filename}.LZH
  410.  
  411.         Loop until no more files in directory
  412.  
  413.  
  414. Upload Directory Processor (C) 1990 ZebbWare Products   16/Jan/1990  Page 7
  415.  
  416.  
  417. Temporary Files & Directorys
  418.  
  419.      UDPROC Creates the following temporary files & directory.
  420.  
  421.      Directory ├┼┼┼┼┼┼┤ is used to unzip & unlzh archives into,
  422. and then it is used by pak to PAK up its contents.  Should you get
  423. stuck with this directory, it can be accessed by using the ascii
  424. values:  HOLD THE ALT KEY, press 1, 9, 5 on the keypad, RELEASE ALT KEY
  425.          HOLD THE ALT KEY, press 1, 9, 7 on the keypad, RELEASE ALT KEY
  426.          HOLD THE ALT KEY, press 1, 9, 7 on the keypad, RELEASE ALT KEY
  427.          HOLD THE ALT KEY, press 1, 9, 7 on the keypad, RELEASE ALT KEY
  428.          HOLD THE ALT KEY, press 1, 9, 7 on the keypad, RELEASE ALT KEY
  429.          HOLD THE ALT KEY, press 1, 9, 7 on the keypad, RELEASE ALT KEY
  430.          HOLD THE ALT KEY, press 1, 9, 7 on the keypad, RELEASE ALT KEY
  431.          HOLD THE ALT KEY, press 1, 8, 0 on the keypad, RELEASE ALT KEY
  432.  
  433.      File YES│NO.TMP - Contains the letter 'Y'.  it is used in
  434. deleting the entire contents of the ├┼┼┼┼┼┼┤ directory.
  435.  
  436.      File HDR│RSP.TMP - Contains the extended archive header filename
  437. you specified with the /H switch.
  438.  
  439.      NOTE:  That strange character between YES & NO in YES│NO.TMP can
  440. be accessed by: 
  441.        HOLD THE ALT KEY, press 1,7,9 on the keypad, RELEASE ALT KEY
  442. <Alt>179 is also the character used between HDR & RSP in HDR│RSP.TMP.
  443.  
  444. Ideally you should never see the above files or directory.
  445.  
  446.  
  447. Error & Return Codes
  448.  
  449.      -1 = No directory entered on Command line or when prompted for it
  450.       0 = Program successfully completed
  451.      10 = Directory  does not exist
  452.      11 = Header File does not exist
  453.      12 = Invalid switch specified on the command line
  454.  
  455. Required Programs (Setup & Memory Information!)
  456.  
  457. NoGate Consulting's PAK.EXE,  PKWARE's PKUNZIP.EXE, and Yoshi's LHARC.EXE
  458. programs are required to use this utility.  They must reside somewhere in
  459. your DOS path environment (ie SET PATH = ).  UDPROC performs no actual 
  460. archiving.  This is done by the 3 above mentioned programs.  UDPROC does,
  461. however, call these programs to do the work for you.  If you don't know
  462. about Dos PATH's I suggest you read your DOS manual.
  463.  
  464. Also, since UDPROC calls these programs which in turn read other
  465. programs into memory, you should have AT LEAST 350K available when
  466. executing UDPROC.  (In other words, don't run UDPROC on top of OPUS when
  467. you are using some conventional memory for a ramdisk!).  MORE is BETTER!
  468.  
  469.  
  470. Last Word :        "Electrodynamics"
  471.